home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d16 / oriel.arc / README.TXT < prev    next >
Text File  |  1991-07-31  |  13KB  |  340 lines
  1. ***** README.TXT file for Oriel for Windows, Version 1.1 *****
  2.  
  3.  
  4. **The Oriel for Windows Demo Program**
  5.  
  6. Oriel for Windows comes with a demonstration program named
  7. DEMO.ORL. We invite you to try it out. The DEMO.ORL program
  8. actually serves as a shell to call various other Oriel
  9. sample programs. These sample programs show you different
  10. ways you might use Oriel and provide example code that you
  11. can use as a reference when building your own Oriel
  12. programs.
  13.  
  14.     In order for the DEMO.ORL program to work, it, and all
  15. the files that come with it, must be in the same directory
  16. as the Oriel executable file (ORIEL.EXE). If you used the
  17. SETUP.EXE program that comes on the Windows 3 Power Tools
  18. diskette to install Oriel, this should already be the case.
  19. See Appendix A of the Windows 3 Power Tools book for
  20. information on how to use the SETUP.EXE program.
  21.  
  22.     You can run the DEMO.ORL program in one of two ways. On
  23. the one hand, you can use the File Run command from either 
  24. Program Manager or File Manager. For example, if you
  25. intalled Oriel in the C:\WINDOWS\PWR-TOOL\ORIEL directory,
  26. you can run the DEMO.ORL program by using the following
  27. command line for the the File Run command:
  28.  
  29. C:\WINDOWS\PWR-TOOL\ORIEL\ORIEL.EXE DEMO.ORL
  30.  
  31. When you press ENTER to confirm this command line, the main 
  32. DEMO.ORL screen is displayed. Follow the instructions on
  33. your screen to take a tour of Oriel.
  34.  
  35.  
  36. **Managing Files and Directories**
  37.  
  38. We've added nine new functions to the Oriel for Windows
  39. command language that let you manage files and directories.
  40. These functions are not described in the book. The sections
  41. that follow explain what these functions are and give
  42. examples of their use.
  43.  
  44.  
  45. FileCopy
  46.  
  47. The FileCopy command lets you copy one or more files from
  48. one directory to another. You can also copy a file and
  49. rename it in the process. If the file already exists in the
  50. target location, the FileCopy command will overwrite it.
  51. This command takes the following form:
  52.  
  53. FileCopy("Source-name",Destination-name",Result)
  54.  
  55.     The "Source-name" argument defines the path and name of
  56. the file (or files) you want to copy. If the file is located 
  57. outside the current directory or on a different drive, make
  58. sure you include the full path and file name--for example,
  59. "D:\ACCTG\BUDGET.ASC". You can also use the standard DOS
  60. wildcards (* and ?) to define a group of files to copy--for
  61. example "D:\ACCTG\*.ASC".
  62.  
  63.     The "Destination-name" argument defines the target
  64. location (and optionally the new name) of the copied file.
  65. Normally, this will be a directory--for example, "\BACKUP\".
  66. Notice that backslash follows the name of the directory.
  67. This is required. If the directory is located on a different
  68. drive, make sure you include the drive designation in the
  69. directory path--for example "D:\BACKUP\". You can also use
  70. the DOS * wildcard in the "Destination-name" argument to
  71. rename a group of files with a different extension--for
  72. example "D:\BACKUP\*.BAK". However, the ? wildcard is not
  73. supported. Finally, if you are copying a single file, you
  74. can define a new name for the file in the target location--
  75. for example, "D:\BACKUP\BACKBUD.TXT".
  76.  
  77.     The Result argument is simply the name of a variable
  78. that indicates whether the copy operation was successful. If
  79. the operation was successful, this variable takes on a value
  80. of 1. Otherwise, it is given a value of 0. Although, the
  81. name "Result" is used for this variable here, you can use
  82. any name you want--for example, There1.
  83.  
  84.     The following example copies all files in the directory
  85. C:\BUDGET\ that have a .TXT extension to a directory named
  86. \BACKUP\ on drive D:
  87.  
  88. FileCopy("C:\BUDGET\*.TXT","D:\BACKUP\",Result)
  89.  
  90.  
  91. FileDelete
  92.  
  93. The FileDelete command lets you delete one or more files.
  94. This command takes the following form:
  95.  
  96. FileDelete("Filename",Result)
  97.  
  98.     The "filename" argument defines the name of the file
  99. you want to delete. If the file is located outside the
  100. current directory or on a different drive, precede the file
  101. name with the needed path--for example,
  102. "D:\ACCTG\OLDFILE.BAK". You can also define a group of files
  103. to delete by using the standard DOS wildcards * and ?--for
  104. example, "D:\ACCTG\*.BAK".
  105.  
  106.     The Result argument is a name of a variable that
  107. indicates whether the deletion was successful. If the file
  108. has been deleted, this variable is assigned a value of 1.
  109. Otherwise a value of 0 is assigned. You can use any name you
  110. want for this variable--for example, There1.
  111.  
  112.     The following example, deletes the file name BUDGET.BAK
  113. in the directory name \ACCTG\ on drive D:
  114.  
  115. FileDelete("D:\ACCTG\BUDGET.BAK",Result)
  116.  
  117.  
  118. FileExist
  119.  
  120. The FileExist command lets you determine whether a file
  121. exists. This command takes the form:
  122.  
  123. FileExist("Filename",Result)
  124.  
  125.     The "Filename" argument defines the name of the file
  126. whose existence you want to verify. If the file is located
  127. outside the current directory or on a different drive,
  128. precede the file name with the appropriate path information-
  129. -for example, "D:\ACCTG\OLDFILE.BAK". The Result argument is
  130. a variable that indicates whether the file exists or not. If
  131. the file does exist, this variable is assigned a value of 1.
  132. Otherwise it is assigned a value of 0.
  133.  
  134.     The following example, verifies the existence of a file
  135. named OLDFILE.BAK in the \ACCTG directory on drive D:
  136.  
  137. FileExist("D:\ACCTG\OLDFILE.BAK",Result)
  138.  
  139.  
  140. FileMove
  141.  
  142. The FileMove command lets you move one or more files from
  143. one directory to another. (This is accomplished by copying
  144. the file to the destination location first and then removing
  145. it from the source location.) If the file already exists in
  146. the destination location, FileMove overwrites it. This
  147. command takes the following form:
  148.  
  149. FileMove("Source-name","Destination-name",Result)
  150.  
  151.     The "Source-name" argument defines the name of the file
  152. you want to move. If the file is located outside the current
  153. directory or on a different drive, make sure you include the
  154. full path and file name--for example, "D:\ACCTG\BUDGET.ASC".
  155. You can also use the standard DOS wild-cards (* and ?) to
  156. define a group of files to move--for example
  157. "D:\ACCTG\*.ASC".
  158.  
  159.     The "Destination-name" argument defines the destination
  160. location for the moved file. Normally, this will be a
  161. directory--for example, "\BACKUP\". Notice that backslash
  162. follows the name of the directory. This is required. If the
  163. directory is located on a different drive, make sure you
  164. include the drive designation in the directory path--for 
  165. example "D:\BACKUP\". You can use the DOS * wildcard in the
  166. "Destination-name" argument to rename file with a different
  167. extension--for example "D:\BACKUP\*.BAK". However, use of
  168. the ? wild card is not supported.
  169.  
  170.     The Result argument is the name of a variable that
  171. indicates whether the move operation was successful. If the
  172. operation was successful, this variable takes on a value of
  173. 1. Otherwise, it is given a value of 0. Although, the name
  174. "Result" is used here, you can use any name you want--for
  175. example, There1.
  176.  
  177.     The following example moves the file BUDGET.TXT from
  178. the \ACCTG\ directory on drive C to the \BACKUP\ directory
  179. on drive D:
  180.  
  181. FileMove("C:\ACCTG\BUDGET.TXT","D:\BACKUP\",Result)
  182.  
  183.  
  184. FileRename
  185.  
  186. The FileRename command lets you change the name of one or
  187. more files. If a file already exists under the new name in
  188. the destination location, the FileRename command will
  189. overwrite it. This command takes the following form:
  190.  
  191. FileRename("Source-name","Destination-name",Result)
  192.  
  193.     The "Source-name" argument defines the path and name of
  194. the file or files you want to rename. If the file is located
  195. outside the current directory or on a different drive, you
  196. must include the full path and file name--for example,
  197. "D:\ACCTG\BUDGET.ASC". You can also use the standard DOS
  198. wild-cards (* and ?) to define a group of files to rename--
  199. for example "D:\ACCTG\*.ASC".
  200.  
  201.     The "Destination-name" argument defines the new name
  202. for the file. If the file you are renaming is located
  203. outside the current directory or on a different drive, make
  204. sure you include both the full path and new name for the
  205. file--for example "D:\ACCTG\BUDBACK.BAK". You can also use
  206. the DOS * wildcard in the "Destination-name" argument to
  207. rename a group of files with a different extension--for
  208. example "D:\BACKUP\*.BAK". However, the ? wild card is not
  209. supported.
  210.  
  211.     The Result argument is the name of a variable that
  212. indicates whether the renaming operation was successful. If
  213. the operation was successful, this variable is assigned a
  214. value of 1. Otherwise, it is given a value of 0. Although,
  215. the name "Result" is used here, you can use any name you
  216. want for this variable--for example, There1.
  217.  
  218.     The following example renames the file BUDG.WK1 in the
  219. directory \ACCTG on drive C: with the same name and a .BAK
  220. extension:
  221.  
  222. FileRename("C:\ACCTG\BUDG.WK1","C:\ACCTG\BUDG.BAK",Result)
  223.  
  224.  
  225. DirChange
  226.  
  227. The DirChange command lets you make a specific directory
  228. current. If the directory you attempt to make current does
  229. not exist, this command will fail. This command takes the
  230. following form:
  231.  
  232. DirChange("Directory-name",Result)
  233.  
  234.     The "Directory-name" argument defines the name of the
  235. directory you want to make current. If the directory is on
  236. another drive, you must precede the directory name with the
  237. appropriate drive designation--for example,
  238. "D:\ACCTG\BUDGET\".
  239.  
  240.     The Result argument is the name of a variable that
  241. indicates whether the directory change operation was
  242. successful. If the operation was successful, this variable
  243. is assigned a value of 1. If it was unsuccessful--the
  244. directory does not exist--this variable is assigned a value
  245. of 0. Although the name Result is used here for this
  246. variable, you can use any name you want--for example,
  247. There1.
  248.  
  249.  
  250. DirMake
  251.  
  252. The DirMake command lets you create a new directory. This
  253. command takes the following form:
  254.  
  255. DirMake("Directory-name",Result)
  256.  
  257. The "Directory-name" argument defines the name of the
  258. directory you want to create. You must specify a fully
  259. qualified path for the new directory--for example,
  260. "C:\ACCT\BUDGET".
  261.  
  262.     The Result argument is a variable name that indicates
  263. whether the create directory operation was successful. If it
  264. was, this variable is assigned a value of 1. If the
  265. operation was not successful--for example, an element of the
  266. pathname does not exist--the Result variable is assigned a
  267. value of 0. Although the name Result is used for this
  268. variable here, you can use any name you want--for example,
  269. There1.
  270.  
  271.     The following example creates a subdirectory named
  272. \MYFILES on the \WINDOWS directory on drive C:
  273.  
  274. DirMake("C:\WINDOWS\MYFILES",Result)
  275.  
  276.  
  277. DirRemove
  278.  
  279. The DirRemove command lets you delete an existing directory.
  280. If the directory does not exist or contains files, this
  281. command will fail. This command takes the following form:
  282.  
  283. DirRemove("Directory-name",Result)
  284.  
  285. The "Directory-name" argument defines the name of the
  286. directory you want to delete. You must specify a fully
  287. qualified path for the directory--for example,
  288. "C:\ACCT\BUDGET".
  289.  
  290.     The Result argument is a variable that indicates
  291. whether deletion of the directory was successful. If it was
  292. successful, this variable is assigned a value of 1. If the
  293. operation was not successful--for example, an element of the
  294. pathname does not exist--the Result variable is assigned a
  295. value of 0. Although the name Result is used for this
  296. variable here, you can use any name you want--for example,
  297. There1.
  298.  
  299.     The following example deletes a subdirectory named
  300. \MYFILES of the \WINDOWS directory on drive C:
  301.  
  302. DirRemove("C:\WINDOWS\MYFILES",Result)
  303.  
  304.  
  305. DiskChange
  306.  
  307. The DiskChange command lets you make another disk drive
  308. current. When you change disk drives with this command, the
  309. directory that was last used on that drive becomes the
  310. current directory. This command takes the following form:
  311.  
  312. DiskChange("Drive-letter",Result)
  313.  
  314.     The "Drive-letter" argument lets you define the letter
  315. of the drive you want to make current--for example "D". You
  316. do not need to supply a colon. (In fact, anything after the
  317. first letter is ignored.)
  318.  
  319.     The Result argument is simply the name of a variable
  320. that indicates whether the disk change operation was
  321. successful. If it was, this variable is assigned a value of
  322. 1. If it was not successful, this variable is assigned a
  323. value of 0. Although the name "Result" is used here for this
  324. variable, you can use any name you want--for example,
  325. There1.
  326.  
  327.     The following example, makes drive E the current drive:
  328.  
  329. DiskChange("E",Result) 
  330.  
  331. Note: You can use the DiskChange command before using the
  332. FileCopy, FileDelete, FileExist, FileMove, FileRename,
  333. DirChange, or DirRemove command. That way, you don't need to
  334. specify a drive designation in the arguments for these
  335. commands.
  336.  
  337.  
  338. We sincerely hope you enjoy Oriel for Windows, Version 1.1.
  339.  
  340. The LeBlond Group, Inc.